Non-Coded CDA Document
Domain Message Specification

Version: 1.1; Status: Final

ReferenceURL Tabular View

COCD_TP146248GB01
ReferenceURL

A template to support the sending of a URL in a CDA document. This URL is to external information relevant or supportive to the CDA document.

This class is used to carry a URL to the relevant external information.

Note: The information contained in the file that is referenced must not be fundamental to the CDA document in that it must be safe to ignore the link. When this is not the case the information must be included within the document.

Used by:
[1..1] [M] classCode (CS { CNE: ActClass } )
{ Fixed="OBS" }

Model Attribute Description

The HL7 attribute classCode uses a code to describe this class as an observation.

Implementation in XML Instance

The XML attribute classCode is fixed to "OBS".

[1..1] [M] moodCode (CS { CNE: ActMood } )
{ Fixed="EVN" }

Model Attribute Description

The HL7 attribute moodCode uses a code to describe this class as an observation event.

Implementation in XML Instance

The XML attribute moodCode is fixed to "EVN".

[1..1] [M] code (CV { CWE:ReferenceURLType } )

Model Attribute Description

The HL7 attribute code uses a code from any available vocabulary that can describe the type of referenced URL.

Where no vocabulary exists the ReferenceURLType vocabulary shall be used.

Implementation in XML Instance

The Coded Plain flavour data type flavour of coded value (CV) shall be used to carry this information as follows:

When the ReferenceURLType vocabulary is used then the XML element code is populated as follows:

  • The XML attribute code shall contain "01"
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.336"
  • The XML attribute displayName shall contain "URL"

When an alternative vocabulary is used and an OID is available then the XML element code is populated as follows:

  • The XML attribute code shall contain the code from the alternative vocabulary
  • The XML attribute codeSystem shall contain the OID for the alternative vocabulary
  • The XML attribute displayName shall carry the description associated with the code from the alternative vocabulary.

When an alternative vocabulary is used and an OID is not available then the XML element code is populated as follows:

  • The XML attribute code shall contain the code from the alternative vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.17.338"
  • The XML attribute displayName shall carry the description associated with the code from the alternative vocabulary.

[1..1] [M] id (II)

Model Attribute Description
The HL7 attribute id uses an identifier to identify this instance of a reference URL.

Implementation in XML Instance

The Identifier Global data type flavour is used to carry this information in the XML element id as follows:

  • The XML attribute root shall contain a DCE UUID.
[1..1] [M] templateId (II)
{ Fixed="COCD_TP146248GB01#ReferenceURL" }

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the classname within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP146248GB01#ReferenceURL"
[1..1] [M] text (ED)

Model Attribute Description

The HL7 attribute text is used to allow the sending of a URL to some related information referenced in a CDA document.

Implementation in XML Instance

The XML element text shall contain the reference URL

  • For example: "http://www.nhs.uk/conditions/pandemic-flu/Pages/Introduction.aspx"